home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ssyevd.z / ssyevd
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSYEVD - compute all eigenvalues and, optionally, eigenvectors of a real
  10.      symmetric matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSYEVD( JOBZ, UPLO, N, A, LDA, W, WORK, LWORK, IWORK, LIWORK,
  14.                         INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, LDA, LIWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           A( LDA, * ), W( * ), WORK( * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      SSYEVD computes all eigenvalues and, optionally, eigenvectors of a real
  39.      symmetric matrix A. If eigenvectors are desired, it uses a divide and
  40.      conquer algorithm.
  41.  
  42.      The divide and conquer algorithm makes very mild assumptions about
  43.      floating point arithmetic. It will work on machines with a guard digit in
  44.      add/subtract, or on those binary machines without guard digits which
  45.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  46.      conceivably fail on hexadecimal or decimal machines without guard digits,
  47.      but we know of none.
  48.  
  49.      Because of large use of BLAS of level 3, SSYEVD needs N**2 more workspace
  50.      than SSYEVX.
  51.  
  52.  
  53. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  54.      JOBZ    (input) CHARACTER*1
  55.              = 'N':  Compute eigenvalues only;
  56.              = 'V':  Compute eigenvalues and eigenvectors.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangle of A is stored;
  76.              = 'L':  Lower triangle of A is stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrix A.  N >= 0.
  80.  
  81.      A       (input/output) REAL array, dimension (LDA, N)
  82.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading N-
  83.              by-N upper triangular part of A contains the upper triangular
  84.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  85.              triangular part of A contains the lower triangular part of the
  86.              matrix A.  On exit, if JOBZ = 'V', then if INFO = 0, A contains
  87.              the orthonormal eigenvectors of the matrix A.  If JOBZ = 'N',
  88.              then on exit the lower triangle (if UPLO='L') or the upper
  89.              triangle (if UPLO='U') of A, including the diagonal, is
  90.              destroyed.
  91.  
  92.      LDA     (input) INTEGER
  93.              The leading dimension of the array A.  LDA >= max(1,N).
  94.  
  95.      W       (output) REAL array, dimension (N)
  96.              If INFO = 0, the eigenvalues in ascending order.
  97.  
  98.      WORK    (workspace/output) REAL array,
  99.              dimension (LWORK) On exit, if INFO = 0, WORK(1) returns the
  100.              optimal LWORK.
  101.  
  102.      LWORK   (input) INTEGER
  103.              The dimension of the array WORK.  If N <= 1,               LWORK
  104.              must be at least 1.  If JOBZ = 'N' and N > 1, LWORK must be at
  105.              least 2*N+1.  If JOBZ = 'V' and N > 1, LWORK must be at least 1 +
  106.              6*N + 2*N**2.
  107.  
  108.              If LWORK = -1, then a workspace query is assumed; the routine
  109.              only calculates the optimal size of the WORK array, returns this
  110.              value as the first entry of the WORK array, and no error message
  111.              related to LWORK is issued by XERBLA.
  112.  
  113.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  114.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  115.  
  116.      LIWORK  (input) INTEGER
  117.              The dimension of the array IWORK.  If N <= 1,
  118.              LIWORK must be at least 1.  If JOBZ  = 'N' and N > 1, LIWORK must
  119.              be at least 1.  If JOBZ  = 'V' and N > 1, LIWORK must be at least
  120.              3 + 5*N.
  121.  
  122.              If LIWORK = -1, then a workspace query is assumed; the routine
  123.              only calculates the optimal size of the IWORK array, returns this
  124.              value as the first entry of the IWORK array, and no error message
  125.              related to LIWORK is issued by XERBLA.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      INFO    (output) INTEGER
  141.              = 0:  successful exit
  142.              < 0:  if INFO = -i, the i-th argument had an illegal value
  143.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  144.              diagonal elements of an intermediate tridiagonal form did not
  145.              converge to zero.
  146.  
  147. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  148.      Based on contributions by
  149.         Jeff Rutter, Computer Science Division, University of California
  150.         at Berkeley, USA
  151.      Modified by Francoise Tisseur, University of Tennessee.
  152.  
  153.  
  154. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  155.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  156.  
  157.      This man page is available only online.
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.